<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content=
    "application/xhtml+xml; charset=iso-8859-1" />
    <title>
      DocBook-utils-0.6.14
    </title>
    <link rel="stylesheet" type="text/css" href="../stylesheets/lfs.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
    <link rel="stylesheet" href="../stylesheets/lfs-print.css" type=
    "text/css" media="print" />
  </head>
  <body class="blfs" id="blfs-9.1">
    <div class="navheader">
      <h4>
        Beyond Linux<sup>�</sup> From Scratch <span class="phrase">(System
        V</span> Edition) - Version 9.1
      </h4>
      <h3>
        Chapter&nbsp;48.&nbsp;Standard Generalized Markup Language (SGML)
      </h3>
      <ul>
        <li class="prev">
          <a accesskey="p" href="docbook-dsssl.html" title=
          "docbook-dsssl-1.79">Prev</a>
          <p>
            docbook-dsssl-1.79
          </p>
        </li>
        <li class="next">
          <a accesskey="n" href="xml.html" title=
          "Extensible Markup Language (XML)">Next</a>
          <p>
            Extensible Markup Language (XML)
          </p>
        </li>
        <li class="up">
          <a accesskey="u" href="sgml.html" title=
          "Chapter&nbsp;48.&nbsp;Standard Generalized Markup Language (SGML)">
          Up</a>
        </li>
        <li class="home">
          <a accesskey="h" href="../index.html" title=
          "Beyond Linux� From Scratch     (System V Edition) - Version 9.1">Home</a>
        </li>
      </ul>
    </div>
    <div class="sect1" lang="en" xml:lang="en">
      <h1 class="sect1">
        <a id="docbook-utils" name="docbook-utils"></a>DocBook-utils-0.6.14
      </h1>
      <div class="package" lang="en" xml:lang="en">
        <h2 class="sect2">
          Introduction to DocBook-utils
        </h2>
        <p>
          The <span class="application">DocBook-utils</span> package is a
          collection of utility scripts used to convert and analyze SGML
          documents in general, and DocBook files in particular. The scripts
          are used to convert from DocBook or other SGML formats into
          <span class="quote">&ldquo;<span class=
          "quote">classical</span>&rdquo;</span> file formats like HTML, man,
          info, RTF and many more. There's also a utility to compare two SGML
          files and only display the differences in markup. This is useful
          for comparing documents prepared for different languages.
        </p>
        <p>
          This package is known to build and work properly using an LFS-9.1
          platform.
        </p>
        <h3>
          Package Information
        </h3>
        <div class="itemizedlist">
          <ul class="compact">
            <li class="listitem">
              <p>
                Download (HTTP): <a class="ulink" href=
                "https://sourceware.org/ftp/docbook-tools/new-trials/SOURCES/docbook-utils-0.6.14.tar.gz">
                https://sourceware.org/ftp/docbook-tools/new-trials/SOURCES/docbook-utils-0.6.14.tar.gz</a>
              </p>
            </li>
            <li class="listitem">
              <p>
                Download (FTP): <a class="ulink" href=
                "ftp://sourceware.org/pub/docbook-tools/new-trials/SOURCES/docbook-utils-0.6.14.tar.gz">
                ftp://sourceware.org/pub/docbook-tools/new-trials/SOURCES/docbook-utils-0.6.14.tar.gz</a>
              </p>
            </li>
            <li class="listitem">
              <p>
                Download MD5 sum: 6b41b18c365c01f225bc417cf632d81c
              </p>
            </li>
            <li class="listitem">
              <p>
                Download size: 124 KB
              </p>
            </li>
            <li class="listitem">
              <p>
                Estimated disk space required: 1.44 MB
              </p>
            </li>
            <li class="listitem">
              <p>
                Estimated build time: less than 0.1 SBU
              </p>
            </li>
          </ul>
        </div>
        <h3>
          Additional Downloads
        </h3>
        <div class="itemizedlist">
          <ul class="compact">
            <li class="listitem">
              <p>
                Required patch: <a class="ulink" href=
                "http://www.linuxfromscratch.org/patches/blfs/9.1/docbook-utils-0.6.14-grep_fix-1.patch">
                http://www.linuxfromscratch.org/patches/blfs/9.1/docbook-utils-0.6.14-grep_fix-1.patch</a>
              </p>
            </li>
          </ul>
        </div>
        <h3>
          DocBook-utils Dependencies
        </h3>
        <h4>
          Required
        </h4>
        <p class="required">
          <a class="xref" href="openjade.html" title=
          "OpenJade-1.3.2">OpenJade-1.3.2</a>, <a class="xref" href=
          "docbook-dsssl.html" title=
          "docbook-dsssl-1.79">docbook-dsssl-1.79</a>, and <a class="xref"
          href="sgml-dtd-3.html" title="docbook-3.1">docbook-3.1</a>
        </p>
        <h4>
          Optional (Runtime Dependencies Only)
        </h4>
        <p class="optional">
          <a class="xref" href="../general/perl-modules.html#perl-sgmlspm"
          title="SGMLSpm-1.1">SGMLSpm-1.1</a> (for conversion to man and
          texinfo), and <a class="xref" href="../basicnet/lynx.html" title=
          "Lynx-2.8.9rel.1">Lynx-2.8.9rel.1</a> or <a class="xref" href=
          "../basicnet/links.html" title="Links-2.20.2">Links-2.20.2</a> or
          <a class="ulink" href="http://w3m.sourceforge.net/">W3m</a> (for
          conversion to ASCII text)
        </p>
        <p class="usernotes">
          User Notes: <a class="ulink" href=
          "http://wiki.linuxfromscratch.org/blfs/wiki/docbook-utils">http://wiki.linuxfromscratch.org/blfs/wiki/docbook-utils</a>
        </p>
      </div>
      <div class="installation" lang="en" xml:lang="en">
        <h2 class="sect2">
          Installation of DocBook-utils
        </h2>
        <p>
          Install <span class="application">DocBook-utils</span> by running
          the following commands:
        </p>
        <pre class="userinput">
<kbd class=
"command">patch -Np1 -i ../docbook-utils-0.6.14-grep_fix-1.patch &amp;&amp;
sed -i 's:/html::' doc/HTML/Makefile.in                &amp;&amp;

./configure --prefix=/usr --mandir=/usr/share/man      &amp;&amp;
make</kbd>
</pre>
        <p>
          This package does not come with a test suite.
        </p>
        <p>
          Now, as the <code class="systemitem">root</code> user:
        </p>
        <pre class="root">
<kbd class="command">make docdir=/usr/share/doc install</kbd>
</pre>
        <p>
          Many packages use an alternate name for the <span class=
          "application">DocBook-utils</span> scripts. If you wish to create
          these alternate names, use the following command as the
          <code class="systemitem">root</code> user:
        </p>
        <pre class="root">
<kbd class="command">for doctype in html ps dvi man pdf rtf tex texi txt
do
    ln -svf docbook2$doctype /usr/bin/db2$doctype
done</kbd>
</pre>
        <div class="admon note">
          <img alt="[Note]" src="../images/note.png" />
          <h3>
            Note
          </h3>
          <p>
            The <span class="command"><strong>jw</strong></span> script uses
            the <span class="command"><strong>which</strong></span> command
            to locate required utilities. You must install <a class="xref"
            href="../general/which.html" title=
            "Which-2.21 and Alternatives">Which-2.21</a> before attempting to
            use any of the <span class="application">DocBook-utils</span>
            programs.
          </p>
        </div>
      </div>
      <div class="commands" lang="en" xml:lang="en">
        <h2 class="sect2">
          Command Explanations
        </h2>
        <p>
          <span class="command"><strong>patch -Np1 -i
          ../docbook-utils-0.6.14-grep_fix-1.patch</strong></span>: This
          patch corrects the syntax in the jw (Jade Wrapper) script which is
          at the heart of much db2* processing, so that the current version
          of <span class="application">Grep</span> will not reject it.
        </p>
        <p>
          <span class="command"><strong>sed -i 's:/html::'
          doc/HTML/Makefile.in</strong></span>: This command changes the
          installation directory of the HTML documents.
        </p>
        <p>
          <code class="option">docdir=/usr/share/doc</code>: This option is
          placed on the <span class="command"><strong>make
          install</strong></span> line because is is not recognized by
          <span class="command"><strong>configure</strong></span>.
        </p>
      </div>
      <div class="content" lang="en" xml:lang="en">
        <h2 class="sect2">
          Contents
        </h2>
        <div class="segmentedlist">
          <div class="seglistitem">
            <div class="seg">
              <strong class="segtitle">Installed Programs:</strong>
              <span class="segbody">docbook2dvi, docbook2html, docbook2man,
              docbook2pdf, docbook2ps, docbook2rtf, docbook2tex,
              docbook2texi, docbook2txt, jw, and sgmldiff</span>
            </div>
            <div class="seg">
              <strong class="segtitle">Installed Libraries:</strong>
              <span class="segbody">None</span>
            </div>
            <div class="seg">
              <strong class="segtitle">Installed Directories:</strong>
              <span class="segbody">/usr/share/doc/docbook-utils-0.6.14 and
              /usr/share/sgml/docbook/utils-0.6.14</span>
            </div>
            <div class="seg">
              <strong class="segtitle">Installed Symlinks:</strong>
              <span class="segbody">db2dvi, db2html, db2man, db2pdf, db2ps,
              db2rtf, db2tex, db2texi, and db2txt</span>
            </div>
          </div>
        </div>
        <div class="variablelist">
          <h3>
            Short Descriptions
          </h3>
          <table border="0" class="variablelist">
            <colgroup>
              <col align="left" valign="top" />
              <col />
            </colgroup>
            <tbody>
              <tr>
                <td>
                  <p>
                    <a id="docbook2" name="docbook2"></a><span class=
                    "term"><span class=
                    "command"><strong>docbook2*</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    are simple one-line wrapper scripts to <span class=
                    "command"><strong>jw</strong></span>. They are provided
                    as easy-to-remember names used to convert DocBook or
                    other SGML files to the respective format.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="db2" name="db2"></a><span class=
                    "term"><span class="command"><strong>db2*</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    are symlinks pointing at the respectively named
                    <span class="command"><strong>docbook2*</strong></span>
                    commands, created to satisfy some program's use of these
                    names.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="jw" name="jw"></a><span class="term"><span class=
                    "command"><strong>jw</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    is a script used to convert DocBook or other SGML files
                    to various output formats. It hides most of <span class=
                    "application">OpenJade</span>'s complexity and adds
                    comfortable features.
                  </p>
                </td>
              </tr>
              <tr>
                <td>
                  <p>
                    <a id="sgmldiff" name="sgmldiff"></a><span class=
                    "term"><span class=
                    "command"><strong>sgmldiff</strong></span></span>
                  </p>
                </td>
                <td>
                  <p>
                    is used to compare two SGML files and only return the
                    differences in the markup. This is especially useful to
                    compare files that should be identical except for
                    language differences in the content.
                  </p>
                </td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <p class="updated">
        Last updated on 2020-02-16 15:15:05 -0800
      </p>
    </div>
    <div class="navfooter">
      <ul>
        <li class="prev">
          <a accesskey="p" href="docbook-dsssl.html" title=
          "docbook-dsssl-1.79">Prev</a>
          <p>
            docbook-dsssl-1.79
          </p>
        </li>
        <li class="next">
          <a accesskey="n" href="xml.html" title=
          "Extensible Markup Language (XML)">Next</a>
          <p>
            Extensible Markup Language (XML)
          </p>
        </li>
        <li class="up">
          <a accesskey="u" href="sgml.html" title=
          "Chapter&nbsp;48.&nbsp;Standard Generalized Markup Language (SGML)">
          Up</a>
        </li>
        <li class="home">
          <a accesskey="h" href="../index.html" title=
          "Beyond Linux� From Scratch     (System V Edition) - Version 9.1">Home</a>
        </li>
      </ul>
    </div>
  </body>
</html>
